Skip to main content
POST
/
api
/
plans
/
{plan_hash}
Incluir aluno em um pacote de cursos
curl --request POST \
  --url https://kong.api.toolzz.com.br/api/plans/{plan_hash} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "<string>",
  "nome": "<string>",
  "schools": [
    123
  ],
  "status": "<string>",
  "expires_at": "<string>"
}'

​
Parâmetros

​
email
string
required
Endereço de e-mail do aluno que será incluído no pacote de cursos.
​
plan_uuid
string
required
Identificador do pacote alvo
​
nome
string
required
Nome do aluno que será incluído no pacote de cursos.
​
schools
number[]
required
Lista que pode conter um ou mais identificadores de escolas às quais o aluno será matriculado.
​
status
string
required
Status da inscrição no pacote. Pode ser:active: O aluno está ativo no pacote.expired: O aluno teve sua inscrição expirada.
​
expires_at
string
Data de vencimento do pacote de cursos do aluno.
Antes de utilizar este endpoint, certifique-se de possuir os seguintes parâmetros disponíveis:
  • email obrigatório: Endereço de e-mail do aluno que está sendo matriculado.
  • nome obrigatório: Nome do aluno que está sendo matriculado.
  • schools obrigatório: Lista de IDs de escolas às quais o aluno está sendo matriculado.

​
Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para proteger os dados dos usuários.